/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions Copyrighted [year] [name of copyright owner]".
 *
 * Copyright 2016 Agile Digital Engineering
 */

package org.forgerock.openam.sts.soap.healthcheck;

/**
 * This interface exposes the necessary information to be able to perform a health check of the STS.
 */
public interface HealthCheck {

    /**
     * Set the number of currently published STS instances
     * 
     * @param numPublishedInstances The number of publish STS instances to set
     */
    void setNumPublishedInstances(int numPublishedInstances);
    
    /**
     * @return Get the number of published STS instances.
     */
    int getNumPublishedInstances();
}
